Skip to content

Comments

Fix reload instructions to be platform-specific and actionable#31

Merged
nhorton merged 4 commits intomainfrom
fix/platform-specific-reload-instructions
Jan 15, 2026
Merged

Fix reload instructions to be platform-specific and actionable#31
nhorton merged 4 commits intomainfrom
fix/platform-specific-reload-instructions

Conversation

@tylerwillis
Copy link
Contributor

Summary

  • Fix confusing /reload instructions that don't exist in Claude Code
  • Add reload_instructions property to adapters with platform-specific text
  • Update deepwork sync to display reload instructions after syncing
  • Update instruction files to tell agent to relay sync output to user directly

Problem

Users were told to run /reload after defining a job, but this command doesn't exist in Claude Code. They had to figure out on their own that they needed to exit and restart.

Solution

  1. Platform-specific reload instructions in adapters:

    • Claude Code: "Type 'exit' then run 'claude --resume'"
    • Gemini CLI: "Run '/memory refresh'"
  2. deepwork sync now displays reload instructions:

    ✓ Sync complete!
    
    To use the new commands:
      Claude Code: Type 'exit' to leave your current session, then run 'claude' (fresh start) or 'claude --resume' (keep conversation history).
    
  3. Instruction files tell agent to relay (not reference) the instructions:

    • Before: "Tell user to follow reload instructions from sync output" (bad UX - user has to scroll up)
    • After: "Look at sync output and relay these exact instructions to user" (agent tells user directly)

Test plan

  • Run /deepwork_jobs.define then /deepwork_jobs.implement to create a new job
  • Verify deepwork sync output shows platform-specific reload instructions
  • Verify agent tells user the specific reload steps (not just "see sync output")

🤖 Generated with Claude Code

Previously, instruction files told users to run `/reload` which doesn't
exist in Claude Code. Users were confused and didn't know how to pick
up newly created commands.

Changes:
- Add `reload_instructions` property to adapters with platform-specific text
- Update `deepwork sync` to display reload instructions after syncing
- Update instruction files to tell agent to relay sync output to user
- Remove all `/reload` references from instruction files

Now when an agent runs `deepwork sync`, it sees the reload instructions
in the output and tells the user exactly what to do:
- Claude Code: "Type 'exit' then run 'claude --resume'"
- Gemini CLI: "Run '/memory refresh'"

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Jan 15, 2026

All contributors have signed the CLA. ✅
Posted by the DCO Assistant Lite bot.

github-actions bot added a commit that referenced this pull request Jan 15, 2026
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@nhorton nhorton merged commit c9763e4 into main Jan 15, 2026
2 checks passed
@nhorton nhorton deleted the fix/platform-specific-reload-instructions branch January 15, 2026 16:53
github-merge-queue bot pushed a commit that referenced this pull request Jan 15, 2026
* Fix CLA signatures file format

Replace Markdown with JSON array - CLA Assistant action
expects JSON format for storing signatures.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix CLA signatures JSON structure

CLA Assistant expects { "signedContributors": [] } format,
not a plain array.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Remove manually created signatures file

Per CLA Assistant docs: "You do not need to create this file manually.
Our workflow will create the signature file if it does not already exist.
Manually creating this file will cause the workflow to fail."

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Creating file for storing CLA Signatures

* @nhorton has signed the CLA in #27

* @tylerwillis has signed the CLA in #31

* Add automated CI test for Claude Code integration

Add a deterministic 'fruits' test job and comprehensive CI tests to validate
that deepwork-generated commands work correctly with Claude Code.

Changes:
- Add fruits job fixture (identify + classify steps) for CI testing
- Add integration tests for fruits workflow (8 tests)
- Add e2e tests for Claude Code execution (3 tests, skipped without API key)
- Add GitHub Actions workflow for automated testing:
  - validate-generation: Always runs, tests command generation
  - claude-code-e2e: Runs with ANTHROPIC_API_KEY, tests actual execution

The fruits job is designed to be deterministic:
- Input: comma-separated list of items (e.g., "apple, car, banana")
- Step 1: Identify which items are fruits
- Step 2: Classify fruits by category (citrus, tropical, etc.)

* Fix CI workflow: use deepwork install with --path, add concurrency rules

- Add concurrency rules to ensure only one instance runs per PR
- Fix test to use 'deepwork install --platform claude --path test_project'
- Create .claude directory before install for platform detection
- Run commands from repo root with --path flag instead of cd'ing

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
nhorton added a commit that referenced this pull request Jan 15, 2026
* Fix CLA signatures file format

Replace Markdown with JSON array - CLA Assistant action
expects JSON format for storing signatures.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix CLA signatures JSON structure

CLA Assistant expects { "signedContributors": [] } format,
not a plain array.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Remove manually created signatures file

Per CLA Assistant docs: "You do not need to create this file manually.
Our workflow will create the signature file if it does not already exist.
Manually creating this file will cause the workflow to fail."

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Creating file for storing CLA Signatures

* @nhorton has signed the CLA in #27

* @tylerwillis has signed the CLA in #31

* Add automated CI test for Claude Code integration

Add a deterministic 'fruits' test job and comprehensive CI tests to validate
that deepwork-generated commands work correctly with Claude Code.

Changes:
- Add fruits job fixture (identify + classify steps) for CI testing
- Add integration tests for fruits workflow (8 tests)
- Add e2e tests for Claude Code execution (3 tests, skipped without API key)
- Add GitHub Actions workflow for automated testing:
  - validate-generation: Always runs, tests command generation
  - claude-code-e2e: Runs with ANTHROPIC_API_KEY, tests actual execution

The fruits job is designed to be deterministic:
- Input: comma-separated list of items (e.g., "apple, car, banana")
- Step 1: Identify which items are fruits
- Step 2: Classify fruits by category (citrus, tropical, etc.)

* Fix CI workflow: use deepwork install with --path, add concurrency rules

- Add concurrency rules to ensure only one instance runs per PR
- Fix test to use 'deepwork install --platform claude --path test_project'
- Create .claude directory before install for platform detection
- Run commands from repo root with --path flag instead of cd'ing

* Add full e2e test: define -> implement -> execute workflow

Update the claude-code-e2e job to test the COMPLETE DeepWork workflow:
1. /deepwork_jobs.define - Create a new job from scratch
2. /deepwork_jobs.implement - Generate step instruction files
3. /fruits.identify - Execute the generated identify command
4. /fruits.classify - Execute the generated classify command

This tests the actual user experience rather than just validating
pre-existing fixtures. The test provides deterministic instructions
for creating a 'fruits' job with identify and classify steps.

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
nhorton added a commit that referenced this pull request Jan 15, 2026
* Fix CLA signatures file format

Replace Markdown with JSON array - CLA Assistant action
expects JSON format for storing signatures.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix CLA signatures JSON structure

CLA Assistant expects { "signedContributors": [] } format,
not a plain array.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Remove manually created signatures file

Per CLA Assistant docs: "You do not need to create this file manually.
Our workflow will create the signature file if it does not already exist.
Manually creating this file will cause the workflow to fail."

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Creating file for storing CLA Signatures

* @nhorton has signed the CLA in #27

* @tylerwillis has signed the CLA in #31

* Fix CI workflow to run on all PRs

Remove the `branches: ["*"]` filter from the pull_request trigger.
The glob pattern `*` doesn't match `/`, so PRs targeting branches
with slashes (like feature/...) were not triggering the workflow.

By removing the filter, the workflow now runs on all PRs regardless
of target branch, while still not running on post-merge to main
(since there's no push trigger).

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
nhorton added a commit that referenced this pull request Jan 15, 2026
* Fix CLA signatures file format

Replace Markdown with JSON array - CLA Assistant action
expects JSON format for storing signatures.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix CLA signatures JSON structure

CLA Assistant expects { "signedContributors": [] } format,
not a plain array.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Remove manually created signatures file

Per CLA Assistant docs: "You do not need to create this file manually.
Our workflow will create the signature file if it does not already exist.
Manually creating this file will cause the workflow to fail."

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Creating file for storing CLA Signatures

* @nhorton has signed the CLA in #27

* @tylerwillis has signed the CLA in #31

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants